com.highdeal.hci
Class AuthenticationFailedException

java.lang.Object
  java.lang.Throwable
      java.lang.Exception
          com.highdeal.hci.OperationFailureException
              com.highdeal.hci.AuthenticationFailedException

All Implemented Interfaces:

OperationResult, XMLMarshallable, java.io.Serializable

public class AuthenticationFailedException
extends OperationFailureException

Exception thrown when an error occurs during the authentication of the SAP CC user that is the message originator.

Reasons

The possible reasons are:

• invalid_login_or_password: There is no match for the logon/password combination
• locked_user: The SAP CC user is locked
• expired_password: The password of the SAP CC user has expired. This error can only occur if the advanced. password management feature is enabled.
• communication_error: A communication error occurred with the authentication server or with the database server system
• invalid_permission: The SAP CC user does not have enough permissions to authenticate on the server system
• invalid_session_id: The session identifier specified in the XML envelope does not match any existing user session
• invalid_session_user: The SAP CC user specified is not linked to the specified session identifier
• session_limit_reached: There are too many sessions for the same user and tool
• password_change_needed: The SAP CC user must change his password at his next logon. This error can only occur if the advanced password management feature is enabled.

See Also:

Serialized Form

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="authenticationFailedFault">
   <xs:complexType>
     <xs:attribute name="reason" type="authenticationFailedReason"/>
     <xs:attribute name="message" type="xs:string"/>
   </xs:complexType>
 </xs:element>

 <xs:simpleType name="authenticationFailedReason">
   <xs:restriction base="xs:string">
     <xs:enumeration value="invalid_login_or_password"/>
     <xs:enumeration value="expired_password"/>
     <xs:enumeration value="locked_user"/>
     <xs:enumeration value="communication_error"/>
     <xs:enumeration value="invalid_permission"/>
     <xs:enumeration value="invalid_session_id"/>
     <xs:enumeration value="invalid_session_user"/>
     <xs:enumeration value="session_limit_reached"/>
     <xs:enumeration value="password_change_needed"/>
   </xs:restriction>
 </xs:simpleType>

Field Summary

static int	COMMUNICATION_ERROR 3: Constant for the communication_error error
static int	EXPIRED_PASSWORD 1: Constant for the expired_password error
static int	INVALID_LOGIN_OR_PASSWORD 0: Constant for the invalid_login_or_password error
static int	INVALID_PERMISSION 4: Constant for the invalid_permission error
static int	INVALID_SESSION_ID 5: Constant for the invalid_session_id error
static int	INVALID_SESSION_USER 6: Constant for the invalid_session_user error
static int	LOCKED_USER 2: Constant for the locked_user error
static int	PASSWORD_CHANGE_NEEDED 8: Constant for the password_change_needed error
static int	SESSION_LIMIT_REACHED 7: Constant for the session_limit_reached error

Constructor Summary

AuthenticationFailedException()
Constructs an empty exception.

AuthenticationFailedException(int reason, java.lang.String message)
Constructs an exception with a reason and a message.

Method Summary

void	addCharacterData(java.lang.String cData) Adds character data to the content element.
void	addChild(java.lang.String tagName, XMLMarshallable child) Adds a child to the object, the child representing the marshallable object which must be added to the element.
java.lang.String	getMessage() Returns the text message of the exception.
java.lang.String	getOperandReference() Gets the code or the reference (if no code exists) that identifies the operand of the operation request; If the operation is not auditable, the operand reference is null.
int	getReason() Returns the numeric reason code of the exception.
void	marshal(XMLOutputter output) Gives an XML representation of this object, including its children.
void	setAttributes(XMLAttributes atts) Sets the attributes of the XML representation of the element being processed.
void	setMessage(java.lang.String message) Sets the message of the exception.
void	setReason(int reason) Sets the numeric reason code of the exception.

Methods inherited from class java.lang.Throwable

fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

INVALID_LOGIN_OR_PASSWORD

public static final int INVALID_LOGIN_OR_PASSWORD

0: Constant for the invalid_login_or_password error

See Also:

Constant Field Values

EXPIRED_PASSWORD

public static final int EXPIRED_PASSWORD

1: Constant for the expired_password error

See Also:

Constant Field Values

LOCKED_USER

public static final int LOCKED_USER

2: Constant for the locked_user error

See Also:

Constant Field Values

COMMUNICATION_ERROR

public static final int COMMUNICATION_ERROR

3: Constant for the communication_error error

See Also:

Constant Field Values

INVALID_PERMISSION

public static final int INVALID_PERMISSION

4: Constant for the invalid_permission error

See Also:

Constant Field Values

INVALID_SESSION_ID

public static final int INVALID_SESSION_ID

5: Constant for the invalid_session_id error

See Also:

Constant Field Values

INVALID_SESSION_USER

public static final int INVALID_SESSION_USER

6: Constant for the invalid_session_user error

See Also:

Constant Field Values

SESSION_LIMIT_REACHED

public static final int SESSION_LIMIT_REACHED

7: Constant for the session_limit_reached error

See Also:

Constant Field Values

PASSWORD_CHANGE_NEEDED

public static final int PASSWORD_CHANGE_NEEDED

8: Constant for the password_change_needed error

See Also:

Constant Field Values

Constructor Detail

AuthenticationFailedException

public AuthenticationFailedException()

Constructs an empty exception.

AuthenticationFailedException

public AuthenticationFailedException(int reason,
                                     java.lang.String message)

Constructs an exception with a reason and a message.

Parameters:

reason - The numerical reason code of the exception

message - The text message of the exception

Method Detail

getReason

public int getReason()

Returns the numeric reason code of the exception.

Returns:

The numerical reason code of the exception

getMessage

public java.lang.String getMessage()

Returns the text message of the exception.

Overrides:

getMessage in class java.lang.Throwable

Returns:

The detailed message of the exception

setReason

public void setReason(int reason)

Sets the numeric reason code of the exception.

Parameters:

reason - The numerical reason code of the exception

setMessage

public void setMessage(java.lang.String message)

Sets the message of the exception.

Parameters:

message - The message of the exception

setAttributes

public void setAttributes(XMLAttributes atts)

Description copied from interface: XMLMarshallable

Sets the attributes of the XML representation of the element being processed.

Parameters:

atts - The XML attributes of the current element

addCharacterData

public void addCharacterData(java.lang.String cData)

Description copied from interface: XMLMarshallable

Adds character data to the content element.

Parameters:

cData - The character data to be added

addChild

public void addChild(java.lang.String tagName,
                     XMLMarshallable child)

Description copied from interface: XMLMarshallable

Adds a child to the object, the child representing the marshallable object which must be added to the element.

Parameters:

tagName - The name of tag for the child

child - The child to be added

marshal

public void marshal(XMLOutputter output)

Description copied from interface: XMLMarshallable

Gives an XML representation of this object, including its children.

Parameters:

output - The XML output to marshal the object into

getOperandReference

public java.lang.String getOperandReference()

Description copied from interface: OperationResult

Gets the code or the reference (if no code exists) that identifies the operand of the operation request; If the operation is not auditable, the operand reference is null.

Specified by:

getOperandReference in interface OperationResult

Overrides:

getOperandReference in class OperationFailureException

Returns:

The operand reference of the operation result